/**
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.merak.core.model.settings;

import java.util.LinkedList;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;

/**
 * Copyright © 2010-2012 Merak Computing. All rights reserved.<br><br>
 *
 * Methods and declarations for Plugin.
 *
 * @author fmarinho.
 * @version 1.00.00 - Aug 27, 2012 - fmarinho - initial version.
 *
 * @since MerakCore 1.00.00
 */
 @XmlAccessorType(XmlAccessType.FIELD)
public class Plugin {

	@XmlAttribute private String service  = null;
	@XmlAttribute private String provider = null;

	@XmlElement(name="provider")
	private List<Provider> providers = new LinkedList<Provider>();

	/**
	 * The service where to plug the provider, it is, the name of the class acting as
	 * Service Provider Interface (the interface).
	 * @since v 1.00.00
	 */
	public String getService() {
		return this.service;
	}

	/**
	 * The provider able to be plugged into service, it is, the path and name of the class
	 * acting as Service Provider (the implementation).
	 * It is a shorthand for unique provider without property, avoiding to nest a Provider tag.
	 * @return The provider inlined in the own Plugin tag.
	 * @since v 1.00.00
	 */
	public String getProvider() {
		return this.provider;
	}

	/**
	 * Many providers able to be plugged into one service, it is, the path and name of the class
	 * acting as Service Provider (the implementation).
	 * It allows declaring many providers with properties.
	 * @return The providers declared in nested Provider tags.
	 * @since v 1.00.00
	 */
	public List<Provider> getProviders() {
		return this.providers;
	}

}
